/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.client.gui.panel;

import java.awt.FlowLayout;
import java.awt.LayoutManager;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.awt.event.MouseListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.logging.Logger;

import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.InputMap;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.KeyStroke;

import net.sf.freecol.client.ClientOptions;
import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.client.control.InGameController;
import net.sf.freecol.client.gui.ImageLibrary;
import net.sf.freecol.client.gui.SwingGUI;
import net.sf.freecol.common.model.Colony;
import net.sf.freecol.common.model.Game;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.Specification;


/**
 * Superclass for all panels in FreeCol.
 */
public abstract class FreeColPanel extends MigPanel implements ActionListener
{

    private static final Logger logger = Logger.getLogger( FreeColPanel.class.getName( ) );

    protected static final String CANCEL = "CANCEL";
    protected static final String OK = "OK";
    protected static final String HELP = "HELP";

    // The margin to use.
    protected static final int MARGIN = 3;

    private final FreeColClient freeColClient;

    protected boolean editable = true;

    protected JButton okButton = Utility.localizedButton( "ok" );


    /**
     * Constructor.
     *
     * @param freeColClient The <code>FreeColClient</code> for the game.
     */
    public FreeColPanel( FreeColClient freeColClient )
    {
        this( freeColClient, new FlowLayout( ) );
    }

    /**
     * Default constructor.
     *
     * @param freeColClient The <code>FreeColClient</code> for the game.
     * @param layout The <code>LayoutManager</code> to be used.
     */
    public FreeColPanel( FreeColClient freeColClient, LayoutManager layout )
    {
        super( layout );

        this.freeColClient = freeColClient;

        setBorder( FreeColImageBorder.imageBorder );

        okButton.setActionCommand( OK );
        okButton.addActionListener( this );
        setCancelComponent( okButton );
    }


    /**
     * Get the FreeColClient.
     *
     * @return The current <code>FreeColClient</code>.
     */
    protected FreeColClient getFreeColClient( )
    {
        return freeColClient;
    }

    /**
     * Is this panel editable?
     *
     * @return True if the panel is editable.
     */
    protected boolean isEditable( )
    {
        return editable;
    }

    /**
     * Get the game.
     *
     * @return The current <code>Game</code>.
     */
    protected Game getGame( )
    {
        return freeColClient.getGame( );
    }

    /**
     * Get the GUI.
     *
     * @return The current <code>GUI</code>.
     */
    protected SwingGUI getGUI( )
    {
        return ( SwingGUI ) freeColClient.getGUI( );
    }

    /**
     * Get the image library.
     *
     * @return The <code>ImageLibrary</code>.
     */
    protected ImageLibrary getImageLibrary( )
    {
        return getGUI( ).getImageLibrary( );
    }

    /**
     * Get the game specification.
     *
     * @return The <code>Specification</code>.
     */
    protected Specification getSpecification( )
    {
        return freeColClient.getGame( ).getSpecification( );
    }

    /**
     * Get the player.
     *
     * @return The client <code>Player</code>.
     */
    protected Player getMyPlayer( )
    {
        return freeColClient.getMyPlayer( );
    }

    /**
     * Get the client options.
     *
     * @return The <code>ClientOptions</code>.
     */
    protected ClientOptions getClientOptions( )
    {
        return ( freeColClient == null ) ? null
                : freeColClient.getClientOptions( );
    }

    /**
     * Get the client controller.
     *
     * @return The client <code>InGameController</code>.
     */
    protected InGameController igc( )
    {
        return freeColClient.getInGameController( );
    }

    /**
     * Create a button for a colony.
     *
     * @param colony The <code>Colony</code> to create a button for.
     * @return The new button.
     */
    public JButton createColonyButton( Colony colony )
    {
        JButton button = Utility.getLinkButton( colony.getName( ), null,
                                                colony.getId( ) );
        button.addActionListener( this );
        return button;
    }

    /**
     * Make the given button the CANCEL button.
     *
     * @param cancelButton an <code>AbstractButton</code> value
     */
    public final void setCancelComponent( AbstractButton cancelButton )
    {
        if ( cancelButton == null ) throw new NullPointerException( );

        InputMap inputMap
                = getInputMap( JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT );
        inputMap.put( KeyStroke.getKeyStroke( KeyEvent.VK_ESCAPE, 0, true ),
                      "release" );

        Action cancelAction = cancelButton.getAction( );
        getActionMap( ).put( "release", cancelAction );
    }

    /**
     * Add a routine to be called when this panel closes.
     * Triggered by Canvas.notifyClose.
     *
     * @param runnable Some code to run on close.
     */
    public void addClosingCallback( final Runnable runnable )
    {
        addPropertyChangeListener( new PropertyChangeListener( )
        {
            @Override
            public void propertyChange( PropertyChangeEvent e )
            {
                if ( "closing".equals( e.getPropertyName( ) ) )
                {
                    runnable.run( );
                    // Lambda unsuitable due to use of "this"
                    FreeColPanel.this.removePropertyChangeListener( this );
                }
            }
        } );
    }

    // Interface ActionListener

    /**
     * {@inheritDoc}
     */
    @Override
    public void actionPerformed( ActionEvent ae )
    {
        final String command = ae.getActionCommand( );
        if ( OK.equals( command ) )
        {
            getGUI( ).removeFromCanvas( this );
        }
        else
        {
            logger.warning( "Bad event: " + command );
        }
    }


    // Override Component

    /**
     * {@inheritDoc}
     */
    @Override
    public void removeNotify( )
    {
        super.removeNotify( );

        // removeNotify gets called when a JPanel has no parent any
        // more, that is the best opportunity available for JPanels
        // to be given a chance to remove leak generating references.

        if ( okButton == null ) return; // Been here before

        // We need to make sure the layout is cleared because some
        // versions of MigLayout are leaky.
        setLayout( null );

        okButton.removeActionListener( this );
        okButton = null;

        for ( MouseListener listener : getMouseListeners( ) )
        {
            removeMouseListener( listener );
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void requestFocus( )
    {
        // The OK button requests focus if it exists.
        if ( okButton != null ) okButton.requestFocus( );
    }
}
